juce/source/extras/the jucer/src/model/components/jucer_GroupComponentHandler.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_GROUPCOMPONENTHANDLER_JUCEHEADER__
  27 #define __JUCER_GROUPCOMPONENTHANDLER_JUCEHEADER__
  28
  29
  30 //==============================================================================
  31 /**
  32 */
  33 class GroupComponentHandler  : public ComponentTypeHandler
  34 {
  35 public:
  36     //==============================================================================
  37     GroupComponentHandler()
  38         : ComponentTypeHandler ("Group Box", "GroupComponent", typeid (GroupComponent), 200, 150)
  39     {
  40         registerColour (GroupComponent::outlineColourId, "outline", "outlinecol");
  41         registerColour (GroupComponent::textColourId, "text", "textcol");
  42     }
  43
  44     //==============================================================================
  45     Component* createNewComponent (JucerDocument*)
  46     {
  47         return new GroupComponent ("new group", "group");
  48     }
  49
  50     XmlElement* createXmlFor (Component* comp, const ComponentLayout* layout)
  51     {
  52         GroupComponent* const g = (GroupComponent*) comp;
  53
  54         XmlElement* e = ComponentTypeHandler::createXmlFor (comp, layout);
  55         e->setAttribute ("title", g->getText());
  56
  57         GroupComponent defaultComp (String::empty, String::empty);
  58
  59         if (g->getTextLabelPosition().getFlags() != defaultComp.getTextLabelPosition().getFlags())
  60             e->setAttribute ("textpos", g->getTextLabelPosition().getFlags());
  61
  62         return e;
  63     }
  64
  65     bool restoreFromXml (const XmlElement& xml, Component* comp, const ComponentLayout* layout)
  66     {
  67         GroupComponent* const g = (GroupComponent*) comp;
  68
  69         if (! ComponentTypeHandler::restoreFromXml (xml, comp, layout))
  70             return false;
  71
  72         g->setText (xml.getStringAttribute ("title", g->getText()));
  73         g->setTextLabelPosition (Justification (xml.getIntAttribute ("textpos", g->getTextLabelPosition().getFlags())));
  74
  75         return true;
  76     }
  77
  78     const String getCreationParameters (Component* component)
  79     {
  80         GroupComponent* g = dynamic_cast <GroupComponent*> (component);
  81
  82         return quotedString (component->getName())
  83                 + ",\n"
  84                 + quotedString (g->getText());
  85     }
  86
  87     void fillInCreationCode (GeneratedCode& code, Component* component, const String& memberVariableName)
  88     {
  89         ComponentTypeHandler::fillInCreationCode (code, component, memberVariableName);
  90
  91         GroupComponent* const g = dynamic_cast <GroupComponent*> (component);
  92
  93         String s;
  94
  95         GroupComponent defaultComp (String::empty, String::empty);
  96
  97         if (g->getTextLabelPosition().getFlags() != defaultComp.getTextLabelPosition().getFlags())
  98         {
  99             s << memberVariableName << "->setTextLabelPosition ("
 100               << justificationToCode (g->getTextLabelPosition())
 101               << ");\n";
 102         }
 103
 104         s << getColourIntialisationCode (component, memberVariableName)
 105           << '\n';
 106
 107         code.constructorCode += s;
 108     }
 109
 110     void getEditableProperties (Component* component, JucerDocument& document, Array <PropertyComponent*>& properties)
 111     {
 112         ComponentTypeHandler::getEditableProperties (component, document, properties);
 113
 114         properties.add (new GroupTitleProperty ((GroupComponent*) component, document));
 115         properties.add (new GroupJustificationProperty ((GroupComponent*) component, document));
 116
 117         addColourProperties (component, document, properties);
 118     }
 119
 120 private:
 121     //==============================================================================
 122     class GroupTitleProperty   : public ComponentTextProperty <GroupComponent>
 123     {
 124     public:
 125         GroupTitleProperty (GroupComponent* component_, JucerDocument& document_)
 126             : ComponentTextProperty <GroupComponent> ("text", 200, false, component_, document_)
 127         {}
 128
 129         //==============================================================================
 130         void setText (const String& newText)
 131         {
 132             document.perform (new GroupTitleChangeAction (component, *document.getComponentLayout(), newText),
 133                               "Change group title");
 134         }
 135
 136         const String getText() const
 137         {
 138             return component->getText();
 139         }
 140
 141     private:
 142         class GroupTitleChangeAction  : public ComponentUndoableAction <GroupComponent>
 143         {
 144         public:
 145             GroupTitleChangeAction (GroupComponent* const comp, ComponentLayout& layout, const String& newName_)
 146                 : ComponentUndoableAction <GroupComponent> (comp, layout),
 147                   newName (newName_)
 148             {
 149                 oldName = comp->getText();
 150             }
 151
 152             bool perform()
 153             {
 154                 showCorrectTab();
 155                 getComponent()->setText (newName);
 156                 changed();
 157                 return true;
 158             }
 159
 160             bool undo()
 161             {
 162                 showCorrectTab();
 163                 getComponent()->setText (oldName);
 164                 changed();
 165                 return true;
 166             }
 167
 168             String newName, oldName;
 169         };
 170     };
 171
 172     //==============================================================================
 173     class GroupJustificationProperty  : public JustificationProperty,
 174                                         public ChangeListener
 175     {
 176     public:
 177         GroupJustificationProperty (GroupComponent* const group_, JucerDocument& document_)
 178             : JustificationProperty ("layout", true),
 179               group (group_),
 180               document (document_)
 181         {
 182             document.addChangeListener (this);
 183         }
 184
 185         ~GroupJustificationProperty()
 186         {
 187             document.removeChangeListener (this);
 188         }
 189
 190         void setJustification (const Justification& newJustification)
 191         {
 192             document.perform (new GroupJustifyChangeAction (group, *document.getComponentLayout(), newJustification),
 193                               "Change text label position");
 194         }
 195
 196         const Justification getJustification() const
 197         {
 198             return group->getTextLabelPosition();
 199         }
 200
 201         void changeListenerCallback (ChangeBroadcaster*)     { refresh(); }
 202
 203     private:
 204         GroupComponent* const group;
 205         JucerDocument& document;
 206
 207         class GroupJustifyChangeAction  : public ComponentUndoableAction <GroupComponent>
 208         {
 209         public:
 210             GroupJustifyChangeAction (GroupComponent* const comp, ComponentLayout& layout, const Justification& newState_)
 211                 : ComponentUndoableAction <GroupComponent> (comp, layout),
 212                   newState (newState_),
 213                   oldState (comp->getTextLabelPosition())
 214             {
 215             }
 216
 217             bool perform()
 218             {
 219                 showCorrectTab();
 220                 getComponent()->setTextLabelPosition (newState);
 221                 changed();
 222                 return true;
 223             }
 224
 225             bool undo()
 226             {
 227                 showCorrectTab();
 228                 getComponent()->setTextLabelPosition (oldState);
 229                 changed();
 230                 return true;
 231             }
 232
 233             Justification newState, oldState;
 234         };
 235     };
 236 };
 237
 238
 239 #endif   // __JUCER_GROUPCOMPONENTHANDLER_JUCEHEADER__